Resource URL: /platform/<<version=1>>/auth/access/<USER>

    Overview: This resource applies the standard collection pattern to users.

     Methods: GET

********************************************************************************

Method GET: Determine user's access rights to a file

       URL: GET /platform/<<version=1>>/auth/access/<USER>

Query arguments:
    path=<string> Path to the file. Must be within /ifs.
   share=<string> SMB share name
    zone=<string> Access zone the user is in.
numeric=<boolean> Show the user's numeric identifier.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "access": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies access permissions that the user has to the file information.", 
            "properties": {
              "share": {
                "type": "object", 
                "description": "Specifies the permissions that the user has on the share.", 
                "properties": {
                  "share_permissions": {
                    "type": [
                      {
                        "type": "object", 
                        "description": "Specifies the permissions that the user has on the SHARE.", 
                        "properties": {
                          "share_relevant_aces": {
                            "minItems": 0, 
                            "items": {
                              "type": "object", 
                              "description": "Specifies properties for an Access Control Entry.", 
                              "properties": {
                                "ace": {
                                  "minLength": 0, 
                                  "type": "string", 
                                  "description": "Specifies properties for an Access Control Entry", 
                                  "maxLength": 255
                                }
                              }
                            }, 
                            "type": "array", 
                            "description": "Specifies a list of the relevant Access Control Entries withrespect to the user in the share.", 
                            "maxItems": 4294967295
                          }, 
                          "run_as_root": {
                            "type": "boolean", 
                            "description": "Returns whether run as root is enabled for the user on the share"
                          }, 
                          "impersonate_user": {
                            "type": "boolean", 
                            "description": "Returns whether impersonate user setting is enabled on the share"
                          }, 
                          "expected_permissions": {
                            "minLength": 0, 
                            "type": "string", 
                            "description": "Returns Share level permissions for the user.{ 'read' , 'write' , 'full' or 'none' will be the values}", 
                            "maxLength": 255
                          }, 
                          "impersonate_guest": {
                            "type": "boolean", 
                            "description": "Returns whether impersonate guest setting is enabled for the user on the share."
                          }
                        }
                      }
                    ], 
                    "description": "Specifies share permissions."
                  }, 
                  "effective_user": {
                    "type": [
                      {
                        "type": "object", 
                        "description": "Specifies the persona for the user.", 
                        "properties": {
                          "uid": {
                            "minimum": 0, 
                            "type": "integer", 
                            "description": "Specifies the uid of the user.", 
                            "maximum": 4294967295
                          }, 
                          "type": {
                            "enum": [
                              "user", 
                              "group", 
                              "wellknown"
                            ], 
                            "type": "string", 
                            "description": "Specifies the type, which must be combined with a name."
                          }, 
                          "id": {
                            "minLength": 0, 
                            "type": "string", 
                            "description": "Specifies the serialized form of the persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                            "maxLength": 255
                          }, 
                          "name": {
                            "minLength": 0, 
                            "type": "string", 
                            "description": "Specifies the persona name, which must be combined with a type.", 
                            "maxLength": 255
                          }
                        }
                      }
                    ], 
                    "description": "Returns the effective user based on share settings."
                  }
                }
              }, 
              "id": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the ID of the user.", 
                "maxLength": 255
              }, 
              "file": {
                "type": "object", 
                "description": "Specifies properties for access rights.", 
                "properties": {
                  "is_snapshot": {
                    "type": "boolean", 
                    "description": "Specifies whether path is inside snapshot."
                  }, 
                  "effective_path": {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies absolute path in filesystem.", 
                    "maxLength": 4096
                  }, 
                  "group": {
                    "type": [
                      {
                        "type": "object", 
                        "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                        "properties": {
                          "type": {
                            "enum": [
                              "user", 
                              "group", 
                              "wellknown"
                            ], 
                            "type": "string", 
                            "description": "Specifies the type of persona, which must be combined with a name."
                          }, 
                          "id": {
                            "minLength": 0, 
                            "type": "string", 
                            "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                            "maxLength": 261
                          }, 
                          "name": {
                            "minLength": 0, 
                            "type": "string", 
                            "description": "Specifies the persona name, which must be combined with a type.", 
                            "maxLength": 255
                          }
                        }
                      }
                    ], 
                    "description": "Specifies the persona of the file group."
                  }, 
                  "owner": {
                    "type": [
                      {
                        "type": "object", 
                        "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                        "properties": {
                          "type": {
                            "enum": [
                              "user", 
                              "group", 
                              "wellknown"
                            ], 
                            "type": "string", 
                            "description": "Specifies the type of persona, which must be combined with a name."
                          }, 
                          "id": {
                            "minLength": 0, 
                            "type": "string", 
                            "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                            "maxLength": 261
                          }, 
                          "name": {
                            "minLength": 0, 
                            "type": "string", 
                            "description": "Specifies the persona name, which must be combined with a type.", 
                            "maxLength": 255
                          }
                        }
                      }
                    ], 
                    "description": "Specifies the persona of the file owner."
                  }, 
                  "file_permissions": {
                    "type": [
                      {
                        "type": "object", 
                        "description": "Specifies the permissions that the user has on the file.", 
                        "properties": {
                          "delete_child": {
                            "type": "boolean", 
                            "description": "Specifies if the parent directory has the delete_child property set for the user.  If the delete_child property is set for a user, that user is able to delete the file."
                          }, 
                          "relevant_mode": {
                            "minLength": 0, 
                            "type": "string", 
                            "description": "Specifies the mode bits that are related to the user.", 
                            "maxLength": 255
                          }, 
                          "relevant_aces": {
                            "minItems": 0, 
                            "items": {
                              "type": "object", 
                              "description": "Specifies properties for an Access Control Entry.", 
                              "properties": {
                                "ace": {
                                  "minLength": 0, 
                                  "type": "string", 
                                  "description": "Specifies properties for an Access Control Entry", 
                                  "maxLength": 255
                                }
                              }
                            }, 
                            "type": "array", 
                            "description": "Specifies a list of the relevant Access Control Entrieswith respect to the user in the share.", 
                            "maxItems": 4294967295
                          }, 
                          "sticky": {
                            "type": "boolean", 
                            "description": "Specifies if the parent directory has the stick bit property set indicating only the file's owner may delete the file."
                          }, 
                          "mode": {
                            "minLength": 0, 
                            "type": "string", 
                            "description": "Specifies the mode bits on the file.", 
                            "maxLength": 255
                          }, 
                          "ownership": {
                            "type": "boolean", 
                            "description": "True if the user owns the file."
                          }, 
                          "expected": {
                            "minLength": 0, 
                            "type": "string", 
                            "description": "Specifies the expected access rights for the user on the file.", 
                            "maxLength": 255
                          }
                        }
                      }
                    ], 
                    "description": "Specifies a list of the relevant share permissions for the user."
                  }
                }
              }, 
              "user": {
                "type": "object", 
                "description": "Specifies the persona for the user.", 
                "properties": {
                  "uid": {
                    "minimum": 0, 
                    "type": "integer", 
                    "description": "Specifies the uid of the user.", 
                    "maximum": 4294967295
                  }, 
                  "type": {
                    "enum": [
                      "user", 
                      "group", 
                      "wellknown"
                    ], 
                    "type": "string", 
                    "description": "Specifies the type, which must be combined with a name."
                  }, 
                  "id": {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the serialized form of the persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                    "maxLength": 255
                  }, 
                  "name": {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the persona name, which must be combined with a type.", 
                    "maxLength": 255
                  }
                }
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}
